docs: fill small gaps in http-api, cli, and operations-and-policy#18
Closed
cursor[bot] wants to merge 1 commit into
Closed
docs: fill small gaps in http-api, cli, and operations-and-policy#18cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
- http-api.md: add Web UI section (GET / serves React UI from static/) - http-api.md: clarify run_id uniqueness scope is per-database, not per workspace_id - http-api.md: document HTTP 422 on empty events array (Pydantic min_length=1 constraint) - http-api.md: expand window format note with positive-integer constraint and invalid-value error behavior - cli.md: document actor resolution ( / / 'unknown'); note that --actor is HTTP/SDK-only - operations-and-policy.md: add window format constraints to compute_diff steps (valid units, positive N, OperationError on bad input) - operations-and-policy.md: add 'Promoted baseline release is missing' to Common errors table with cause and fix guidance Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Targeted documentation fixes and additions covering knowledge gaps found by auditing the source code against the existing docs. All changes are verified against the implementation — no fabricated behavior.
Docs updated
docs/http-api.mdGET /serving the React UI fromstatic/index.htmland/assets/*static files; this route was missing entirely.run_iduniqueness scope — clarifies uniqueness is per-database (not "per workspace" as previously stated, which incorrectly impliedworkspace_idpartitions the key).eventsarray — documents HTTP 422 response when"events": []is sent (Pydanticmin_length=1constraint, previously undocumented).windowformat constraints — adds thatNmust be a positive integer; zero/negative/unsupported units return HTTP 400.docs/cli.mdactorfield written to the audit ledger is resolved:$USER(Unix) →$USERNAME(Windows) →"unknown". Clarifies that--actoris HTTP/SDK-only; the CLI resolves it automatically.docs/operations-and-policy.mdwindowformat constraints — expands thecompute_diffsteps to enumerate valid units and noteOperationErroron bad input.Promoted baseline release is missing: rel_...in the Common errors table, covering the case where apromoted_releasespointer references a release row that no longer exists (manual DB edit or truncation). Includes cause and fix guidance.Codepaths covered
src/flightdeck/server/app.py(GET /,/assets/*,GET /health)src/flightdeck/server/routes/ingest.py(POST /v1/events,min_length=1on request body)src/flightdeck/storage.py(run_idPRIMARY KEY,insert_run_eventsdedup)src/flightdeck/ledger.py(parse_window— positive int constraint,d/h/munits)src/flightdeck/operations.py(_evaluate_promotion_or_rollback— promoted baseline missing error)src/flightdeck/cli/main.py(actor_name()resolution logic)Verification
uv run python -m ruff check src tests— all checks passeduv run python -m pytest— 75 passeduv run flightdeck-quickstart-verify— OK